/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   Feb 24, 2020 (Simon Schmid, KNIME GmbH, Konstanz, Germany): created
 */
package org.knime.filehandling.core.data.location;

import org.knime.core.data.DataColumnSpec;
import org.knime.core.data.renderer.AbstractDataValueRendererFactory;
import org.knime.core.data.renderer.DataValueRenderer;
import org.knime.core.data.renderer.DefaultDataValueRenderer;
import org.knime.filehandling.core.connections.FSLocation;

/**
 * Generic renderer for {@link FSLocationValue} which prints the path.
 *
 * @author Timmo Waller-Ehrat, KNIME GmbH, Konstanz, Germany
 * @since 4.2
 * @noreference non-public API
 * @noinstantiate non-public API
 */
public final class FSLocationValueRenderer extends DefaultDataValueRenderer {

    private static final long serialVersionUID = 1L;

    /**
     * Factory initializing a {@link FSLocationValueRenderer} that only shows the paths.
     *
     * @author Timmo Waller-Ehrat, KNIME GmbH, Berlin, Germany
     */
    public static final class PathFactory extends AbstractDataValueRendererFactory {

        private static final String DESCRIPTION = "Path";

        @Override
        public String getDescription() {
            return DESCRIPTION;
        }

        @Override
        public DataValueRenderer createRenderer(final DataColumnSpec colSpec) {
            return new FSLocationValueRenderer(true, DESCRIPTION);
        }
    }

    /**
     * Factory initializing a {@link FSLocationValueRenderer} that shows the complete {@link FSLocationValue} information.
     *
     * @author Timmo Waller-Ehrat, KNIME GmbH, Berlin, Germany
     */
    public static final class CompleteLocationFactory extends AbstractDataValueRendererFactory {

        private static final String DESCRIPTION = "Extended path";

        @Override
        public String getDescription() {
            return DESCRIPTION;
        }

        @Override
        public DataValueRenderer createRenderer(final DataColumnSpec colSpec) {
            return new FSLocationValueRenderer(false, DESCRIPTION);
        }
    }

    private final boolean m_showPathOnly;

    private FSLocationValueRenderer(final boolean showPathOnly, final String description) {
        super(description);
        m_showPathOnly = showPathOnly;
    }

    @Override
    protected void setValue(final Object value) {
        final Object val;
        if (value instanceof FSLocationValue) {
            final FSLocation loc = ((FSLocationValue)value).getFSLocation();
            if (m_showPathOnly) {
                val = loc.getPath();
            } else {
                val = loc.toString();
            }
        } else {
            val = value;
        }
        super.setValue(val);
    }
}
